<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="IdSpec,org.opensocial.client.base.IdSpec,Field,GroupId,PersonId,newInstance" name="keywords">
<title>org.opensocial.client.base.IdSpec</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'IdSpec - OpenSocial Actionscript 3.0 Client Library Documentation';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">OpenSocial Actionscript Client Library</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?org/opensocial/client/base/IdSpec.html&amp;org/opensocial/client/base/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;IdSpec</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#methodSummary">Methods</a>&nbsp;| <a href="#constantSummary">Constants</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class IdSpec"); titleBar_setSubNav(true,false,false,false,false,false,true,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">org.opensocial.client.base</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class IdSpec</td>
</tr>
<tr>
<td class="classHeaderTableLabel">Inheritance</td><td class="inheritanceList">IdSpec <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="MutableDataType.html">MutableDataType</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="DataType.html">DataType</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="AbstractDataType.html">AbstractDataType</a> <img class="inheritArrow" alt="Inheritance" title="Inheritance" src="../../../../images/inherit-arrow.gif"> <a href="BaseType.html">BaseType</a></td>
</tr>
</table>
<p></p>
 Wrapper of <code><j>opensocial.IdSpec</j></code> object in javascript.
  <p></p>
<p>
<span class="classHeaderTableLabel">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec" target="mm_external">opensocial.IdSpec</a>
</div>
<br>
<hr>
</div>
<a name="methodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Methods</div>
<div class="showHideLinks">
<div class="hideInheritedMethod" id="hideInheritedMethod">
<a onclick="javascript:setInheritedVisible(false,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Public Methods</a>
</div>
<div class="showInheritedMethod" id="showInheritedMethod">
<a onclick="javascript:setInheritedVisible(true,'Method');" href="#methodSummary" class="showHideLink"><img src="../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Public Methods</a>
</div>
</div>
<table id="summaryTableMethod" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AbstractDataType.html#create()">create</a>(rawObj:Object):*</div>
<div class="summaryTableDescription">[static]</div>
</td><td class="summaryTableOwnerCol"><a href="AbstractDataType.html">AbstractDataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="MutableDataType.html#createRawObject()">createRawObject</a>():Object</div>
<div class="summaryTableDescription">[static]
   A helper funcion to creates an empty instance.</div>
</td><td class="summaryTableOwnerCol"><a href="MutableDataType.html">MutableDataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#getField()">getField</a>(key:String):Object</div>
<div class="summaryTableDescription">
   Default accessor for all type to get the field value by the field name.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#getFieldArray()">getFieldArray</a>(key:String):<a href="../base/ArrayType.html">ArrayType</a>
</div>
<div class="summaryTableDescription">
   Gets an array by the field key which the elements are primitive types.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#getFieldBoolean()">getFieldBoolean</a>(key:String):Boolean</div>
<div class="summaryTableDescription">
   Gets a boolean value by the field key.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#getFieldData()">getFieldData</a>(key:String, type:Class):<a href="../base/DataType.html">DataType</a>
</div>
<div class="summaryTableDescription">
   Gets a DataType object by the field key.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#getFieldDataArray()">getFieldDataArray</a>(key:String, type:Class):<a href="../base/ArrayType.html">ArrayType</a>
</div>
<div class="summaryTableDescription">
   Gets an array by the field key.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#getFieldDate()">getFieldDate</a>(key:String):Date</div>
<div class="summaryTableDescription">
   Gets a date value by the field key.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#getFieldNumber()">getFieldNumber</a>(key:String):Number</div>
<div class="summaryTableDescription">
   Gets a number value by the field key.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#getFieldString()">getFieldString</a>(key:String):String</div>
<div class="summaryTableDescription">
   Gets a string value by the field key.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AbstractDataType.html#getType()">getType</a>(rawObj:Object):Class</div>
<div class="summaryTableDescription">[static]</div>
</td><td class="summaryTableOwnerCol"><a href="AbstractDataType.html">AbstractDataType</a></td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="#newInstance()">newInstance</a>(userId:String, groupId:String = null, networkDist:Number):<a href="../base/IdSpec.html">IdSpec</a>
</div>
<div class="summaryTableDescription">[static]
   Creates an <code>IdSpec</code> object.</div>
</td><td class="summaryTableOwnerCol">IdSpec</td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="MutableDataType.html#setField()">setField</a>(key:String, value:Object):void</div>
<div class="summaryTableDescription">
   Sets the field value.</div>
</td><td class="summaryTableOwnerCol"><a href="MutableDataType.html">MutableDataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="MutableDataType.html#toRawObject()">toRawObject</a>():Object</div>
<div class="summaryTableDescription">
   Returns the raw object of the <code>DataType</code> object.</div>
</td><td class="summaryTableOwnerCol"><a href="MutableDataType.html">MutableDataType</a></td>
</tr>
<tr class="hideInheritedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AbstractDataType.html#toString()">toString</a>():String</div>
<div class="summaryTableDescription">
   Converts the <code>RawDataType</code> object to a string.</div>
</td><td class="summaryTableOwnerCol"><a href="AbstractDataType.html">AbstractDataType</a></td>
</tr>
</table>
</div>
<a name="protectedMethodSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Protected Methods</div>
<div class="showHideLinks">
<div class="hideInheritedProtectedMethod" id="hideInheritedProtectedMethod">
<a onclick="javascript:setInheritedVisible(false,'ProtectedMethod');" href="#protectedMethodSummary" class="showHideLink"><img src="../../../../images/expanded.gif" class="showHideLinkImage"> Hide Inherited Protected Methods</a>
</div>
<div class="showInheritedProtectedMethod" id="showInheritedProtectedMethod">
<a onclick="javascript:setInheritedVisible(true,'ProtectedMethod');" href="#protectedMethodSummary" class="showHideLink"><img src="../../../../images/collapsed.gif" class="showHideLinkImage"> Show Inherited Protected Methods</a>
</div>
</div>
<table id="summaryTableProtectedMethod" class="summaryTable hideInheritedProtectedMethod" cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Method</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#getFields()">getFields</a>():Object</div>
<div class="summaryTableDescription">
   Get the fields_ property from the opensocial raw object.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AbstractDataType.html#getRawObj()">getRawObj</a>():Object</div>
<div class="summaryTableDescription">
   Accessor to the original wrapped object.</div>
</td><td class="summaryTableOwnerCol"><a href="AbstractDataType.html">AbstractDataType</a></td>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="AbstractDataType.html#getRawProperty()">getRawProperty</a>(key:String):*</div>
<div class="summaryTableDescription">
   Get the property in the wrapped object.</div>
</td><td class="summaryTableOwnerCol"><a href="AbstractDataType.html">AbstractDataType</a></td>
</tr>
<tr class="hideInheritedProtectedMethod">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol"><img class="inheritedSummaryImage" title="Inherited" alt="Inherited" src="../../../../images/inheritedSummary.gif"></td><td class="summaryTableSignatureCol">
<div class="summarySignature">
<a class="signatureLink" href="DataType.html#hasFields()">hasFields</a>():Boolean</div>
<div class="summaryTableDescription">
   For most of the wrapped object from opensocial, there will be a "fields" property.</div>
</td><td class="summaryTableOwnerCol"><a href="DataType.html">DataType</a></td>
</tr>
</table>
</div>
<a name="constantSummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Constants</div>
<table id="summaryTableConstant" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Constant</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#Field">Field</a> : <a href="../base/ConstType.html">ConstType</a>
<div class="summaryTableDescription">[static]
   <code><j>opensocial.IdSpec.Field</j></code> constants.</div>
</td><td class="summaryTableOwnerCol">IdSpec</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#GroupId">GroupId</a> : <a href="../base/ConstType.html">ConstType</a>
<div class="summaryTableDescription">[static]
   <code><j>opensocial.IdSpec.GroupId</j></code> constants.</div>
</td><td class="summaryTableOwnerCol">IdSpec</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#PersonId">PersonId</a> : <a href="../base/ConstType.html">ConstType</a>
<div class="summaryTableDescription">[static]
   <code><j>opensocial.IdSpec.PersonId</j></code> constants.</div>
</td><td class="summaryTableOwnerCol">IdSpec</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="methodDetail"></a>
<div class="detailSectionHeader">Method detail</div>
<a name="newInstance()"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">newInstance</td><td class="detailHeaderParens">()</td><td class="detailHeaderType">method</td>
</tr>
</table>
<div class="detailBody">
<code>public static function newInstance(userId:String, groupId:String = null, networkDist:Number):<a href="../base/IdSpec.html">IdSpec</a></code><p>
   Creates an <code>IdSpec</code> object.
   </p><span class="label">Parameters</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20px"></td><td><code><span class="label">userId</span>:String</code> &mdash; The value for <code>IdSpec.Field.USER_ID</code>, which is an
                 <code>IdSpec.PersonId</code> value.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">groupId</span>:String</code> (default = <code>null</code>)<code></code> &mdash; The value for <code>IdSpec.Field.GROUP_ID</code>.which is an
                 <code>IdSpec.GroupId</code> value.
   </td>
</tr>
<tr>
<td class="paramSpacer">&nbsp;</td>
</tr>
<tr>
<td width="20px"></td><td><code><span class="label">networkDist</span>:Number</code> &mdash; The value for <code>IdSpec.Field.NETWORK_DISTANCE</code>. which is
                      a number.
      </td>
</tr>
</table>
<p></p>
<span class="label">Returns</span>
<table border="0" cellspacing="0" cellpadding="0">
<tr>
<td width="20"></td><td><code><a href="../base/IdSpec.html">IdSpec</a></code> &mdash; 
                        The new instance.
   
                        
                     </td>
</tr>
</table>
</div>
<a name="constantDetail"></a>
<div class="detailSectionHeader">Constant detail</div>
<a name="Field"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">Field</td><td class="detailHeaderType">constant</td>
</tr>
</table>
<div class="detailBody">
<code>public static const Field:<a href="../base/ConstType.html">ConstType</a></code><p>
   <code><j>opensocial.IdSpec.Field</j></code> constants.
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec.Field" target="mm_external">opensocial.IdSpec.Field</a>
</div>
</div>
<a name="GroupId"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">GroupId</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const GroupId:<a href="../base/ConstType.html">ConstType</a></code><p>
   <code><j>opensocial.IdSpec.GroupId</j></code> constants.
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec.GroupId" target="mm_external">opensocial.IdSpec.GroupId</a>
</div>
</div>
<a name="PersonId"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">PersonId</td><td class="detailHeaderType">constant</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>public static const PersonId:<a href="../base/ConstType.html">ConstType</a></code><p>
   <code><j>opensocial.IdSpec.PersonId</j></code> constants.
   </p><p>
<span class="label">See also</span>
</p>
<div class="seeAlso">
<a href="http://code.google.com/apis/opensocial/docs/0.8/reference/#opensocial.IdSpec.PersonId" target="mm_external">opensocial.IdSpec.PersonId</a>
</div>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright">2010 OpenSocial</center>
</div>
</body>
</html>
<!--2010 OpenSocial-->
